/**
 * The contents of this file are subject to the OpenMRS Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://license.openmrs.org
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific language governing rights and limitations
 * under the License.
 *
 * Copyright (C) OpenMRS, LLC.  All Rights Reserved.
 */
package org.openmrs.module.clinicalsummary.rule;

import org.openmrs.Patient;
import org.openmrs.logic.LogicContext;
import org.openmrs.logic.LogicException;
import org.openmrs.logic.Rule;
import org.openmrs.logic.result.Result;
import org.openmrs.logic.rule.RuleParameterInfo;

import java.util.HashSet;
import java.util.Map;
import java.util.Set;

/**
 * A helper for implementing Rules, with no-op implementations of everything but eval.
 */
public abstract class AbstractRule implements Rule {

	/**
	 * @see org.openmrs.logic.Rule#eval(org.openmrs.logic.LogicContext, Patient, java.util.Map)
	 */
	public abstract Result eval(LogicContext context, Patient patient, Map<String, Object> parameters) throws LogicException;

	/**
	 * @see org.openmrs.logic.Rule#getDefaultDatatype()
	 */
	public Result.Datatype getDefaultDatatype() {
		return Result.Datatype.TEXT;
	}

	/**
	 * @see org.openmrs.logic.Rule#getDependencies()
	 */
	public String[] getDependencies() {
		return new String[]{};
	}

	/**
	 * @see org.openmrs.logic.Rule#getParameterList()
	 */
	public Set<RuleParameterInfo> getParameterList() {
		return new HashSet<RuleParameterInfo>();
	}

	/**
	 * @see org.openmrs.logic.Rule#getTTL()
	 */
	public int getTTL() {
		return 30;
	}

}
